Metadata-Version: 2.1
Name: Redj Captcha
Version: 1.1.2
Summary: Django / Rest Framework Captcha
Home-page: https://redj.ai/
Author: redj_ai
Author-email: info@redj.ai
License: UNKNOWN
Project-URL: Bug Tracker, https://redj.ai/
Platform: UNKNOWN
Classifier: Framework :: Django
Classifier: Environment :: Web Environment
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Requires-Python: >=3
Description-Content-Type: text/markdown
License-File: LICENSE

# Redj Captcha
Django / Rest Framework captcha

## Getting Started

> in `setting.py`:

```
INSTALLED_APPS = [
    ...
    'redjcaptcha',
]
```

in terminal `python manage.py migrate`

> in `urls.py` : and :

```
from django.urls import path, include

urlpatterns = [
    ...
    path('', include('redjcaptcha.urls')),
]
```
and check check `http://localhost:8000/captcha`

> check Captcha (django):
```
from redjcaptcha.setup import checkCaptcha

check = checkCaptcha(captcha_key, captcha_value)
if check==False:
    return 'inValid'
```
or use `fullCheckCaptcha` for check `ip` and `User-agent`
```
from redjcaptcha.setup import fullCheckCaptcha

check = fullCheckCaptcha(request)
if check==False:
    return 'inValid'
```

> check Captcha (rest_framework):
```
from rest_framework import serializers
from redjcaptcha.setup import checkCaptcha

class CaptchaSerializer(serializers.Serializer):
    captcha_key = serializers.CharField()
    captcha_value = serializers.CharField()

    def validate(self, data):
        check = checkCaptcha(data['captcha_key'], data['captcha_value'])
        if check==False:
            print('\n=====> Captcha faild')
            raise Exception()

        print('\n=====> Captcha success')
        return check
```

>if use `Redj Log` pakeg:
```
from redjcaptcha import redjlog

redjlog.fullCheckCaptcha(request)
```

> change default setting:
```
from redjcaptcha.setup import init

init(
    size=6,
    debug=True,
    font_size=50,
    timeout=6000,
    type="str-int",
    image_height=70,
    image_weight=180,
    text_color="random",
    background_color="#fff"
)
```

